home *** CD-ROM | disk | FTP | other *** search
/ Mac-Source 1994 July / Mac-Source_July_1994.iso / Apple Script / addons / OSA Menu / OSA Menu 1.0 Docs < prev   
Text File  |  1994-01-21  |  11KB  |  234 lines
  1. OSA Menu 1.0
  2. Written by Leonard Rosenthol
  3. Copyright ©1992-1994, Leonard Rosenthol.
  4.  
  5.  
  6. Installation:
  7. If you are reading this, you've probably already done half the
  8. installation! 
  9.  
  10. The only other thing to do is to drag the OSA Menu icon over your System
  11. folder. Doing so will cause the Finder to inform you that “Extensions go
  12. in the Extensions folder” - this is a good thing, and you should click the
  13. “OK” button. Now restart your Mac, and you'll be all ready to use OSA
  14. Menu.
  15.  
  16.  
  17. Description:
  18. The OSA Menu is an iconic system menu (like the Help menu) that appears on
  19. the right side of the menu bar. Its menu items are scripts: choose an item
  20. from the menu and the script will run. Some commands are always available,
  21. and some are only available within particular applications. 
  22.  
  23. Generally the target of the script is the active application, and scripts
  24. that operate on the user selection are particularly useful. Scripts in the
  25. OSA Menu act like extensions to the command set of the application. 
  26.  
  27. The main advantage to scripts in the menu is that they’re very lightweight.
  28. You can call them up with one mouse click without leaving your current
  29. context for the Finder
  30.  
  31. This is most useful in applications that are scriptable (like Aladdin
  32. Systems' new SITcomm), but require you to switch to another application. 
  33. BUT NO MORE!! Now you can just choose the script you want to run from the
  34. OSA Menu.
  35.  
  36. The scripts live in a folder called "Scripts" in your System folder, and
  37. each application gets its own subfolder of the "Scripts" folder with the
  38. scripts specific to that application as well as a "Universal Scripts"
  39. folder for scripts that you wish to access in all applications.
  40.  
  41.  
  42. What's in the Menu:
  43. The menu has three parts:
  44. *    On top are the fixed commands. Right now there’s only one: the “About OSA
  45. Menu” command that displays an About box.
  46. * Below those are the universal scripts, which always appear.
  47. *    At the bottom are the scripts for the active application.
  48. At the end of each set of scripts is an underlined command that, when
  49. chosen, tells the Finder to open the folder for those scripts. For
  50. instance, when SITcomm is active there is an “Open SITcomm Scripts Folder”
  51. command that opens the “SITcomm Scripts” folder.
  52. These folders are like the Apple Menu Items folder: any script files placed
  53. in them immediately appear in the scripting menu. (They must be compiled
  54. scripts (including Applets and Droplets), not text files.)
  55.  
  56.  
  57. Command Keys:
  58. It is possible to assign a command key to a script by using a special
  59. naming convention. If the name of a script ends with a '\' followed by
  60. another character, then that character will be used as the command key for
  61. the script. For example, the script named "Time Check\T" will have a
  62. command key of "T" in the menu.
  63.  
  64. Use of option or control characters in a menu name is not officially
  65. supported, due to a limitation of the Macintosh Menu Manager. They MAY
  66. work, but if they don't, I am sorry and I have no plans to fix it!!
  67.  
  68.  
  69. Special Features:
  70. * Any of the subfolders of the Scripts folder, or any particular script,
  71. can be an alias. This is very useful for network installations so that all
  72. users can have the same scripts in their menus.
  73. * If you hold down the Option key when selecting a script from the menu,
  74. instead of running the script, the Script Editor will be launched (if not
  75. already running) and the script will be opened for editing.
  76. * If you hold down the Shift key when selecting a script from the menu,
  77. instead of running the script, the Finder will come to the front with the
  78. script selected.
  79.  
  80.  
  81. System Requirements:
  82. OSA Menu requires System 7 and an OSA compliant scripting language
  83. (AppleScript, Userland Frontier, QuicKeys 3, tclScript, etc.). OSA Menu
  84. is 32-bit clean, ‘040 cache, AV and virtual memory compatible. It other
  85. words, as long as you have System 7 and a scripting language it will work!
  86.  
  87.  
  88. Caveats:
  89. * If you move the Scripts folder after the Mac starts up, the folder will
  90. not able to be found by the OSA Menu and you're scripts won't work. So,
  91. don't move it!
  92.  
  93.  
  94. Troubleshooting:
  95. I hope that you won't have any problems with OSA Menu, but if you do you
  96. can contact me using any of the following means:
  97. Leonard Rosenthol
  98. AppleLink: MACgician
  99. America Online: MACgician
  100. Internet: leonardr@netcom.com
  101.  
  102. *** DO NOT CONTACT ALADDIN SYSTEMS ABOUT THIS PRODUCT ***
  103. They have nothing to do with it, other than letting me release to you for
  104. free, so please send all comments, suggestions, complaints, large sums of
  105. money, single jewish women, etc. to me personally!
  106.  
  107.  
  108. Version History:
  109. 1.0  -  First public release (1/21/94)
  110.  
  111.  
  112. Thanks to:
  113. Richard Clark - for writing the original "Scripting Menu" at MacHack '92.
  114. Jens Alfke - for writing the "Scripting Menu" that Apple never shipped, and
  115. for pioneering some techniques.
  116. Don Olson - for helping out with OSA questions & being an all around dude &
  117. 1/2!
  118. Chris Borton - for hassling me to get a "real" icon!
  119. Aladdin Systems - for letting me work on this and release it to the world!
  120. Apple Computer - for NOT shipping their "Scripting Menu", so that I could
  121. do mine
  122. The AppleScript Team, Dave Winer, Doug Baron, Don Brown, and Tim Endres-
  123. for their respective OSA compliant environments w/o which this program
  124. wouldn't make any sense!
  125. All my beta testers - for reporting bugs that I had to fix so you wouldn't
  126. find them!
  127.  
  128.  
  129. Legal Stuff:
  130. Although copyrighted, this software is being licensed to you for your use
  131. free of charge. However, ownership of and interest in this software shall
  132. remain with the author. Use and distribution of this software is governed
  133. by the following terms in an effort to reasonably ensure that this software
  134. will remain freely available and that no one other than the author will
  135. derive a commercial benefit from distributing this software.
  136.  
  137. LICENSE AGREEMENT
  138. “You,” “your,” and the “user” refers to any person or entity which acquires
  139. or uses this software.
  140.  
  141. “Software” refers to any computer programs identified at the start of this
  142. documentation file, together with all codes, techniques, software tools,
  143. formats, designs, concepts, methods, ideas, and documentation associated
  144. with the computer program(s). The term also includes all copies of any
  145. part of the software and documentation.
  146.  
  147. “Author” refers to the author of this software, Leonard Rosenthol.
  148.  
  149. This software is owned by the author and contains valuable and proprietary
  150. information of the author. If you violate any part of this agreement, your
  151. right to use this software terminates automatically. In the event of
  152. termination of this agreement, you must destroy all copies of this software
  153. and derivatives of this software in your possession and cease distributing
  154. the same.
  155.  
  156. This software is being licensed to you as provided by the terms of this
  157. agreement.
  158.  
  159. You may:
  160. 1. Use this software on as many computers as you want at any given time.
  161. 2. Make as many backup copies of this software as you want.
  162. 3. Alter the software in any manner you see fit FOR YOUR OWN PERSONAL USE. 
  163. Such altered versions should not be distributed. The creation of such
  164. derivatives shall not diminish the author's title to this software.
  165. 4. Terminate this agreement at any time by destroying all copies of this
  166. software and derivatives of this software and cease distributing the same.
  167.  
  168. You may not:
  169. 1. Create any derivative works from this software for distribution.
  170. 2. Reverse engineer, disassemble, decompile, or otherwise attempt to
  171. discover the logic or source code to this software.
  172.  
  173. OSA Menu may be distributed for non-commercial purposes. 
  174.  
  175. It may also be freely distributed via wire or electronic communications
  176. (BBS's and online information systems) for the sole purpose of use by their
  177. customers.
  178.  
  179. Contact Leonard Rosenthol at the addresses within this document if you wish
  180. to distribute this software in a compilation or for commercial usage, or if
  181. you have any questions about its redistribution. 
  182.  
  183. Disclaimer of warranty:
  184. In using this software, you understand and agree that this software is
  185. provided “as is” without warranty of any kind. The entire risk as to the
  186. results and performance of using this software lies entirely with you, the
  187. user. The author does not make any warranties, either expressed or
  188. implied, including but not limited to implied warranties of merchantability
  189. and fitness for a particular purpose, with respect to this software.
  190.  
  191. In no event shall the author be liable for any consequential, incidental,
  192. or special damages whatsoever (including without limitation damages for
  193. loss of critical data, loss of profits, interruption of business, and the
  194. like) arising out of the use or inability to use this software. Because
  195. some states do not allow the exclusion or limitation of liability for
  196. consequential or incidental damages, the above limitations may not apply to
  197. you.
  198.  
  199. Although the author would appreciate any feedback and bug reports, the
  200. author shall not be responsible for correcting any problems which you
  201. discover or otherwise help you maintain and use this software. 
  202. Furthermore, the author may at any time replace, modify, alter, improve,
  203. enhance or change this software.
  204.  
  205. Complete agreement:
  206. This agreement constitutes the entire agreement and supersedes any prior
  207. agreements between you and the author concerning this software. This
  208. agreement cannot be amended, modified, or waived except in writing.
  209.  
  210. General:
  211. If any provision of this agreement shall be found to be unenforceable, it
  212. shall be deemed severed from the remainder of this agreement.
  213.  
  214. This agreement shall be construed in accordance with the laws of the State
  215. of California. Any arbitration or litigation relating to this agreement
  216. shall take place in the State of California. The parties further submit to
  217. waive any objections to personal jurisdiction of and venue in any of the
  218. following forums: U.S. District Court for the Northern District of
  219. California, California Superior Court for Santa Cruz County, Santa Cruz
  220. County Municipal Court or any other forum in Santa Cruz County, for any
  221. litigation arising out of this agreement.
  222.  
  223. U.S. GOVERNMENT RESTRICTED RIGHTS
  224. This Software is provided with RESTRICTED RIGHTS. Use, duplication, or
  225. disclosure by the government is subject to restrictions set forth in
  226. subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer
  227. Software clause at 48 CFR 252.227-7013, or in subparagraphs (a) through (d)
  228. of the Commercial Computer Software Restricted Rights clause at 48 CFR
  229. 52.227-19, as applicable. The contractor/manufacturer is Leonard
  230. Rosenthol.
  231.  
  232.  
  233. All trademarks are held by their respective owners.
  234.